Fix the docs for gtk_recent_info_get_application_info()

The documentation for the function says that the app_exec string
should be freed, but we return a pointer to the internal string
without duplicating it. Since the app_exec string is valid as long
as the GtkRecentInfo is valid the documentation should be fixed
and the out argument should be constified. Fixes #584832.

diff --git a/gtk/gtkrecentmanager.c b/gtk/gtkrecentmanager.c
index 317b3d5f5eb02d1520c430962ed466c21c73d337..5cedaa0e548406bdf25eb217baca30d2de156eb4 100644 (file)
--- a/gtk/gtkrecentmanager.c
+++ b/gtk/gtkrecentmanager.c
@@ -1735,15 +1735,16 @@ recent_app_info_free (RecentAppInfo *app_info)
  * storage specification, they will be expanded.
  *
  * Return value: %TRUE if an application with @app_name has registered this
- *   resource inside the recently used list, or %FALSE otherwise.  You should
- *   free the returned command line using g_free().
+ *   resource inside the recently used list, or %FALSE otherwise. The
+ *   @app_exec string is owned by the #GtkRecentInfo and should not be
+ *   modified or freed
  *
  * Since: 2.10
  */
 gboolean
 gtk_recent_info_get_application_info (GtkRecentInfo  *info,
                                      const gchar    *app_name,
-                                     gchar         **app_exec,
+                                     const gchar   **app_exec,
                                      guint          *count,
                                      time_t         *time_)
 {

diff --git a/gtk/gtkrecentmanager.h b/gtk/gtkrecentmanager.h
index 4127e67b21ff9c1fe890aa57399743e8de1095e8..ccc6581594217121353797eb7b61532f5345a10e 100644 (file)
--- a/gtk/gtkrecentmanager.h
+++ b/gtk/gtkrecentmanager.h
@@ -186,7 +186,7 @@ time_t                gtk_recent_info_get_visited          (GtkRecentInfo  *info
 gboolean              gtk_recent_info_get_private_hint     (GtkRecentInfo  *info);
 gboolean              gtk_recent_info_get_application_info (GtkRecentInfo  *info,
                                                            const gchar    *app_name,
-                                                           gchar         **app_exec,
+                                                           const gchar   **app_exec,
                                                            guint          *count,
                                                            time_t         *time_);
 gchar **              gtk_recent_info_get_applications     (GtkRecentInfo  *info,